Tap generate docs: anyOf support and improved error messages #476
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luandy64
force-pushed
the
tap-generate-docs/anyOf-support
branch
from
8fa22a4
to
cfa00e0
Compare
luandy64
force-pushed
the
tap-generate-docs/anyOf-support
branch
from
cfa00e0
to
5d63021
Compare
dmosorast
reviewed
May 4, 2020
There was a problem hiding this comment.
The general gist sounds good, and I trust that the tests prove that.
I'm concerned about the case where the type is something like "anyOf": [{"type": "string"}, {"type": "string", "format": "date-time"}], since merging them seems to remove the notion that this is a special case where the dates can return as invalid, in which case we type them as strings.
KAllan357
approved these changes
May 6, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds the following improvements to
tap-generate-docs:arraywith noitemsfieldobjectsandpropertiesanyOfin schemasI highly recommend hiding whitespace changes while reviewing the PR.
anyOfdesignconvert-multiary-typealready supports schemas with a array for the type of the field.docs/scripts/tap-generate-docs/test/tap_generate_docs_test.clj
Lines 243 to 247 in cb6bbe1
So to support
anyOf, this PR merges all of the maps in theanyOfarray and lets the the existing functions handle the parsing.Notice the test case I added to
convert-multiary-type-testsmirrors the test case right above it (except mine usesanyOf) and the outputs are expected to be the same.Outstanding questions
maybe-remove-anyOf?remove-anyOfwithout my anonymous function passed tomerge-with?